home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 006a / tblt10g.zip / QUICK.DOC < prev    next >
Text File  |  1993-03-28  |  13KB  |  301 lines
  1. /////////////////////////////////////////////////////////////////////////////
  2.  
  3.                                 TOPBLT v1.0g
  4.  
  5.                      PCBoard Top Users Bulletin Generator
  6.  
  7.                      For use with PCBoard Versions 14.5x
  8.  
  9.                       Copyright 1993 by Kendall Anderson
  10.  
  11.                               ALL RIGHTS RESERVED
  12.  
  13. /////////////////////////////////////////////////////////////////////////////
  14.  
  15.                         This program is supported by:
  16.  
  17.                                Kendall Anderson
  18.                             486 Aspen Forest Drive
  19.                               Oakville, Ontario
  20.                                    L6J 6H7
  21.                                    CANADA
  22.  
  23. /////////////////////////////////////////////////////////////////////////////
  24.  
  25. TOPBLT v1.0g QUICK DOC
  26. ======================
  27.  
  28.  
  29. OVERVIEW
  30. ========
  31.  
  32.         TOPBLT is a PCBoard Top Users Bulletin Generator. It generates
  33.         bulletins which allow you to view who's contributing most and
  34.         least to your system (you can create BEST and WORST bulletins).
  35.  
  36.         It is a highly configurable program and runs very quickly.
  37.  
  38.         TOPBLT produces 'multi-output' reports - meaning that each
  39.         bulletin generated is actually two bulletins in one (you could
  40.         create a 'top downloaders & top uploaders' report as one
  41.         bulletin), allowing you to compare similar information quickly
  42.         and easily.
  43.  
  44.  
  45. REGISTRATION
  46. ============
  47.  
  48.         For various reasons, TOPBLT is now distributed as shareware,
  49.         requiring a registration if you wish to continue using it after
  50.         30 days.
  51.  
  52.         TOPBLT is almost fully functional when unregistered. Registration
  53.         allows you the following features:
  54.  
  55.                 - ability to generate bulletins of more than 10 users
  56.                         (unregistered copies can ONLY produce output of
  57.                          10 users)
  58.                 - ability to customize the internal header text (through
  59.                         the TOPTEXT file) and/or to disable the internally
  60.                         generated bulletin headers
  61.                 - ability to remove the time/date stamp at the end of
  62.                         bulletin (or to change its colour to black on black)
  63.  
  64.         You are not allowed to remove the Copyright Statement, or to sell
  65.         this program, or bundle it with other (commercial) goods. You may
  66.         give it to anyone and distribute it anywhere, but only in its
  67.         original form with the complete documentation and all support files.
  68.  
  69.         This program may not be sold as part of a shareware collection
  70.         without prior written consent by the author, Kendall Anderson.
  71.  
  72.         Suggested registration for TOPBLT is $10.
  73.  
  74.         To register, send me the name you'd wish TOPBLT to be registered
  75.         to and let me know how I can contact you to get you your registration
  76.         number. Please send all registrations, postcards, comments and
  77.         suggestions (positive or negative) to:
  78.  
  79.                                 Kendall Anderson
  80.                                 486 Aspen Forest Drive
  81.                                 Oakville, Ontario
  82.                                 L6J 6H7
  83.                                 CANADA
  84.  
  85.         Updates and support for this program may be obtained by calling
  86.         the Structures BBS (416-778-4193) thanks to Stew Francis. Join
  87.         conference 7 and leave mail there.
  88.  
  89.         I may also be reached on Canada Remote Systems (416-629-7020)
  90.         through email.
  91.  
  92.         I also occasionally browse the various PCBoard echoes (Rime, Ilink,
  93.         etc) and may catch messages there as well.
  94.  
  95.  
  96. USAGE
  97. =====
  98.  
  99. TOPBLT v1.0g (03/22/93) Copyright (c) 1993 by K. Anderson. All Rights Reserved.
  100.  
  101. USAGE: TOPBLT config_file blt_1 blt_2 num_users output_file
  102.  
  103. ...where blt_? is [type][sort]
  104.  
  105. type           0 - messages posted     7 - post:call ratio
  106.                1 - messages read       8 - uploads:download ratio
  107.                2 - number downloads    9 - downloads:upload ratio
  108.                3 - number uploads     10 - kbytes ul:file ul ratio
  109.                4 - bytes downloaded   11 - kbytes dl:file dl ratio
  110.                5 - bytes uploaded     12 - kbytes ul:kbyte dl ratio
  111.                6 - number of calls    13 - kbytes dl:kbyte ul ratio
  112.  
  113. sort           a - ascending           d - descending
  114.  
  115. num_users      number of users to include in bulletin (1-99)
  116.  
  117. Examples:
  118. ---------
  119.  
  120. topblt topblt.cfg 0a 1a 15 c:\pcb\gen\blt1
  121.  
  122.         This would create a top 15 message posters and a top 15 message
  123.         readers bulletin, sending the output to a file called BLT1.
  124.  
  125. topblt topblt.cfg 5a 5d 5 c:\pcb\gen\blt2
  126.  
  127.         This would create a bulletin containing the best and worst 5
  128.         uploaders (in kbytes).
  129.  
  130.  
  131. TOPBLT.CFG
  132. ==========
  133.  
  134. Quick Overview
  135. --------------
  136. Kendall Anderson        <- name of the person this program is registered to
  137. 0000000000              <- your registration number
  138. c:\pcb\pcboard.dat      <- path/name of pcboard.dat
  139. yes                     <- do you want internally generated headers? (yes/no)
  140. 1                       <- which header style to use if yes to above (1-3)
  141. yes                     <- do you want header text to be centered? (yes/no)
  142. yes                     <- output any information to screen? (yes/no)
  143. yes                     <- append time/date stamp to the bulletin? (yes/no)
  144. 15                      <- foreground colour for header text (see colour table)
  145. 0                       <- background colour for header text
  146. 15                      <- foreground colour for rank number
  147. 0                       <- background colour for rank number
  148. 10                      <- foreground colour for user name
  149. 0                       <- background colour for user name
  150. 14                      <- foreground colour for the actual statistic value
  151. 0                       <- background colour for the actual statistic value
  152. 7                       <- foreground colour for the time/date stamp
  153. ;
  154. ; remaining lines are exclude filters
  155. ;
  156. Sysop                           <- exclude users named "SYSOP"
  157. exclude security 100-120        <- exclude users with security level 100-120
  158. exclude security 95             <- exclude users with security level 95
  159. exclude min calls 30            <- exclude users with less than 30 calls
  160. exclude min value 1             <- exclude users where the statistic is < 1
  161. Joe User                        <- exclude users named "JOE USER"
  162.  
  163. COLOUR TABLE
  164. ------------
  165.  
  166.         Acceptable foreground colours are 0-15 and acceptable background
  167.         colours are 0-7.
  168.  
  169.         0 black         5 magenta           10 light green
  170.         1 blue          6 brown             11 light cyan
  171.         2 green         7 light grey        12 light red
  172.         3 cyan          8 dark grey         13 light magenta
  173.         4 red           9 light blue        14 yellow
  174.                                             15 white
  175.             
  176. EXCLUDE OPTIONS
  177. ---------------
  178.  
  179.         Nature of the Exclude Options
  180.         -----------------------------
  181.         The exclude filters determine which users will NOT be placed
  182.         in the final bulletin. Place each user name, one per line,
  183.         at the end of the configuration file.
  184.  
  185.         There are special 'filters' you may use in the exclude options.
  186.         You may exclude users based on their security level, the
  187.         number of calls they have made to the system, or the value of
  188.         the particular statistic. The filters are referenced by keywords
  189.         in the exclude area of the configuration file.
  190.  
  191.         Sample Exclude options:
  192.  
  193.         ; dummy line - any line with a semi-colon starting is ignored
  194.         Sysop                           <- exclude user named SYSOP
  195.         exclude security 100-120        <- exclude users with security 100-120
  196.         exclude security 95             <- exclude users with security 95
  197.         exclude min calls 1             <- exclude users with less than 1 call
  198.         Joe User                        <- exclude user names JOE USER
  199.         exclude min value 5             <- if the value of the statistic for
  200.                                              the particular bulletin for any
  201.                                              user is less than 5, exclude the
  202.                                              user (useful for avoiding reports
  203.                                              full of 0's)
  204.  
  205.         There will likely be more filters like the above in future versions
  206.         depending on feedback I receive (the method makes it very
  207.         configurable).
  208.  
  209.         There is a current maximum of 50 exclude filters - this can be raised
  210.         if anybody has a need for more (although I'd be quite surprised
  211.         if anyone will! :) ).
  212.  
  213.  
  214. HEADER and FOOTER Files
  215. =======================
  216.  
  217.         TOPBLT supports the use of user generated header and footer
  218.         files (inserted before and after the bulletin). When TOPBLT is
  219.         run, if it finds the files TOPBLT.HDR or TOPBLT.FTR it will
  220.         place them before or after the bulletin (in that order).
  221.  
  222.         You can put anything you wish in these files. TOPBLT will
  223.         expand the same @ variables usable in TOPTEXT if they are found
  224.         in these files. (@BLTUSERS@, @TOTALUSERS@, @USERSINLIST@, @DATE@,
  225.         @TIME@, and @VERSION@).
  226.  
  227.  
  228. TOPTEXT
  229. =======
  230.  
  231.         The TOPTEXT file provides registered users a method of changing
  232.         the actual text that will be displayed in the internally generated
  233.         bulletins. This file is much like PCBTEXT for PCBoard. Here is
  234.         an example of the TOPTEXT file:
  235.  
  236. ;-------------------------------------------------------------------------;
  237. ; TOPBLT Header Text Redefinition File                                    ;
  238. ; Do NOT delete any of these header lines!                                ;
  239. ; Available @-codes are: @BLTUSERS@ (# of users in the bulletin)          ;
  240. ; @TOTALUSERS@ (# of users on the bulletin board), @x colour codes,       ;
  241. ; @USERSINLIST@ (# users reviewd for bulletin) @DATE@, @TIME@, @VERSION@  ;
  242. ; Prompts should be no longer than 38 characters (after translations)     ;
  243. ;-------------------------------------------------------------------------;
  244. Best
  245. Worst
  246. @BLTUSERS@ Message Posters (# messages)
  247. @BLTUSERS@ Message Readers (# messages)
  248. @BLTUSERS@ Downloaders (# of files)
  249. @BLTUSERS@ Uploaders (# of files)
  250. @BLTUSERS@ Downloaders (kbytes)
  251. @BLTUSERS@ Uploaders (kbytes)
  252. @BLTUSERS@ Callers (# of calls)
  253. @BLTUSERS@ Post:Call Ratios
  254. @BLTUSERS@ Uploads:Download Ratios
  255. @BLTUSERS@ Downloads:Upload Ratios
  256. @BLTUSERS@ Kbytes UL:File Uploaded
  257. @BLTUSERS@ Kbytes DL:File Downloaded
  258. @BLTUSERS@ Kbytes UL:Kbyte Downloaded
  259. @BLTUSERS@ Kbytes DL:Kbyte Uploaded
  260. No other users meet req's
  261. ---------
  262. ;-------------------------------------------------------------------------;
  263. ; end of TOPTEXT file                                                     ;
  264. ;-------------------------------------------------------------------------;
  265.  
  266.         Remember, this file will only be used by REGISTERED versions of
  267.         TOPBLT.
  268.  
  269.         You may change these to virtually anything you'd like and the
  270.         @-codes listed will be interpreted if they are found in header.
  271.  
  272.         This file should be self-explanatory except for perhaps the last
  273.         two items of text - 'No other users meet req's' and '---------'.
  274.  
  275.         These are used when you've placed certain filters on a bulletin,
  276.         such as 'exclude min calls 50' or something that produces a
  277.         bulletin where there aren't enough users that meet the requirement
  278.         to fill the bulletin. The first piece of text is placed as the
  279.         user name and the second as the statistic. These are here so
  280.         that you can customize them to anything you wish, or even just
  281.         make them blank lines.
  282.  
  283.  
  284. DISCLAIMER AND OTHER STUFF
  285. ==========================
  286.  
  287.         The usual nonsense..
  288.  
  289.         I will not be held liable for any misfortune that may or may not
  290.         happen to you, which may or may not be the result of using or not
  291.         using this program. In other words, the usual disclaimer applies
  292.         here.
  293.  
  294.         This Top Bulletins Generator program is provided "AS IS" with no
  295.         claims regarding its usefullness or functionality. You, the user,
  296.         accept full responsibilty and liability for any problems or damages
  297.         associated with its operation.
  298.  
  299. ==========================================================================
  300. <END OF DOCUMENT>
  301.